Repository navigation
ci: Check that SECURITY.md covers the releases - #454
Merged
Merged
Conversation
Signed-off-by: Ferenc Csaky <ferenc@datasqrl.com>
ferenc-csaky
added a commit
that referenced
this pull request
Nov 17, 2026
Signed-off-by: Ferenc Csaky <ferenc@datasqrl.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this change?
SECURITY.mdlisted only 0.11.x as supported, although 0.12.0 to 0.12.5 have been released. This PR lists 0.12.x and 0.11.x as supported, says fixes are backported to the release branches of the supported versions, and adds aRelease docsworkflow (.github/scripts/check-release-docs.py) that fails whileSECURITY.mdfalls behind the releases again. It is the same check as in DataSQRL/sqrl#2614, without the compatibility table part, since the runner has none.The check reads the
X.Y.Ztags of the remote and checks one release line: the latest one onmain, andX.Yon arelease-X.Ybranch or anX.Y.Ztag. Older lines are only checked whileSECURITY.mdlists them as supported.SECURITY.mdmust list the release line as supported, and< oldest supported versionas unsupported.It runs on every PR and push to
mainandrelease-*, and on release tag pushes, instead of only whenSECURITY.mdchanges, because a new tag makes it stale without any file changing. So after a new minor is tagged, PRs fail this check untilSECURITY.mdis updated.RELEASE.mdnow says to update it before tagging a new minor.Follow-up:
release-0.12needs the sameSECURITY.mdchange; the check fails on PRs to that branch until then.Area
README.md,stdlib-docs)How did you test it?
Ran the script locally against this branch, worktrees of
main,release-0.11andrelease-0.12, and the0.11.4and0.12.5tags. The updatedSECURITY.mdpasses; the currentmain,release-0.12and0.12.5fail withmust list 0.12.x as supported;release-0.11and0.11.4pass;release-0.10and pre-release tags are skipped; a malformed supported version and a missing< x.yrow fail. The workflow runs on this PR.Checklist
feat:,fix:ordocs:, optionally with a scope (e.g.fix(flexible-json):)mvn clean installpasses locally and the code is formatted withmvn spotless:apply(no Java changes)given_when_thennaming, AssertJ assertions) (CI script, tested manually as above)pom.xml(not applicable)git commit -s -S)README.mdandstdlib-docsare updated if user-facing behavior or functions changed (not applicable)🤖 Generated with Claude Code